home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 2 / Amiga Tools 2.iso / tex / macros / source / base / decustex.txt < prev    next >
Text File  |  1995-03-15  |  14KB  |  374 lines
  1.      LaTeX installation instructions for DECUS TeX (OpenVMS) 
  2.  
  3.                            15 August 1994 
  4.  
  5.  
  6. SUMMARY 
  7. ======= 
  8.  
  9. This file contains instructions on how to install LaTeX for 
  10. DECUS TeX on OpenVMS.  Before reading this file, you should read 
  11. install.txt, which will explain how the LaTeX installation works. 
  12.  
  13. This file describes: 
  14.  
  15.  * How to save any old version of LaTeX. 
  16.  
  17.  * How to unpack the LaTeX distribution. 
  18.  
  19.  * How to configure LaTeX. 
  20.  
  21.  * How to create the LaTeX format. 
  22.  
  23.  * How to install the LaTeX files. 
  24.  
  25.  * How to check the LaTeX installation. 
  26.  
  27.  * Post Installation Tasks. 
  28.  
  29.  * Running LaTeX with old versions (PD V3.4 and earlier) of DECUS TeX 
  30.  
  31.  
  32. SAVING ANY OLD VERSION OF LaTeX 
  33. =============================== 
  34.  
  35. If you are currently using the old LaTeX version, 2.09, you may wish 
  36. to save it before installing the new version of LaTeX. 
  37.  
  38. a) The old LaTeX 2.09 version will be kept in a subdirectory [.LATEX209] 
  39.    in your TeXinputs tree (normally TEX_ROOT:[INPUTS]). 
  40.  
  41.    When your LaTeX distribution was already installed in a subdirectory 
  42.    (e.g. [.LATEX]), simply execute a rename: 
  43.      RENAME TEX_ROOT:[INPUTS]LATEX.DIR  LATEX209.DIR 
  44.    (You may have to modify the file protection of the directory file.0 
  45.  
  46.    Otherwise, create a new subdirectory TEX_ROOT:[INPUTS.LATEX209] 
  47.    All style files (.STY) as well as LATEX.TEX, LPLAIN.TEX, LFONTS.TEX, 
  48.    SLITEX.TEX, SPLAIN.TEX, SFONTS.TEX, LHYPHEN.TEX, IDX.TEX, LABLST.TEX, 
  49.    MAKEINDEX.TEX, SAMPLE.TEX, SMALL.TEX, TRYFONTS.TEX, TESTPAGE.TEX and 
  50.    TESTA4.TEX should be moved into this directory. 
  51.  
  52. b) You need to set up a separate logical name for the LaTeX-2.09 search 
  53.    list; to prevent interference with the new LaTeX release: 
  54.    Edit the command procedure that is used to initialize the TeX system: 
  55.    This is probably the file STARTTEX.COM, located in TEX_ROOT:[000000]. 
  56.    Search for the definition of the TEX_INPUTS search list. Add a similar 
  57.    definition using another name (.e.g. LTX_INPUTS) by duplicating the 
  58.    search list in STARTTEX.COM. Change this new definition by adding 
  59.    an entry "TEX_ROOT:[INPUTS.LATEX209]" at the top of the list, so 
  60.    that the files from the old LaTeX-2.09 are accessed before the new files 
  61.    from LaTeX2e. 
  62.  
  63. c) To use the old LaTeX 2.09 format, you have to define a new command 
  64.    which uses the new logical name LTX_INPUTS as TeXinputs search path. 
  65.    This is archived by adding the following line to STARTTEX.COM (best 
  66.    place: just after the INITEX command definition): 
  67.  
  68.    "$   OLATEX :== TEX/FORMAT=TEX_FORMATS:LPLAIN/TEXINPUTS=LTX_INPUTS:" 
  69.  
  70. d) There is no need to rename the old format file LPLAIN.FMT. The new LaTeX 
  71.    format uses a different name (LATEX.FMT) per default. 
  72.    But if there is a command procedure to generate the format files, you 
  73.    might want to update it to reflect the changed location of the LaTeX-2.09 
  74.    sources. 
  75.  
  76. To install the recent changes, you have to reexecute the TeX initialization 
  77. procedure. To enshure that all logical names are properly redefined, you 
  78. should delete the logical name TEX_ROOT by 
  79.    "DEASSIGN TEX_ROOT" 
  80. (or simply log out and start a new session). 
  81.  
  82.  
  83. UNPACKING THE DISTRIBUTION 
  84. ========================== 
  85.  
  86. It is recommended that you keep the new LaTeX distributions an a 
  87. separate subdirectory. This simplifys later maintance work. 
  88. To unpack the sources, you should create a new directory, e.g: 
  89. TEX_ROOT:[INPUTS.LATEX.SRC]. 
  90. Copy the hole LaTeX distribution into this directory, and change 
  91. your working directory to this location with a SET DEFAULT command. 
  92. Now simply type 
  93.  "INITEX UNPACK.INS" 
  94. (after you have initialized the TeX system). The unpack procedure 
  95. should then proceed without errors. 
  96. The time needed for Unpacking depends on your hardware equipment. 
  97. On an Alpha AXP machine (DEC 3000/400), this will last less than 5 minutes; 
  98. on an older VAX, you will probably need an order of magnitude more time. 
  99. (But I have never tested it on a VAX...) 
  100.  
  101.  
  102.  
  103. CONFIGURING LATEX 
  104. ================= 
  105.  
  106. A) The TEXSYS.CFG file: 
  107. ----------------------- 
  108. If you have a recent version of DECUS TeX (3.1415, PD V3.5 or later), no 
  109. special texsys.cfg file is needed. DECUS TeX is now fully compatible with 
  110. the extended input checking techniques used in the new LaTeX (LaTeX2e). 
  111. For a usable texsys.cfg setup with older (outdated) versions of DECUS TeX, 
  112. see the section 
  113. "Running LaTeX with old versions (PD 3.4 and earlier) of DECUS TeX" 
  114. below. 
  115.  
  116. B) Setting up multilingual hyphenation patterns: 
  117. ------------------------------------------------ 
  118. If you want to use non USenglish hyphenation patterns (in addition 
  119. or as a replacement), you need to create a configuration file 
  120. "HYPHEN.CFG" to override the LaTeX defaults. 
  121. Your HYPHEN.CFG file should load all required hyphenation patterns. 
  122. At the end, the default language should be switched on and the appropiate 
  123. values of \lefthyphenmin and \righthyphenmin for this language should be 
  124. set. 
  125. It is strongly recommended to load the USenglish hyphenation patterns 
  126. as language 0 and to use this language as default to maintain compatibility 
  127. with other installations. This setup is needed to allow correct processing 
  128. of the delivered (english) LaTeX documentation files! 
  129. As an example for a HYPHEN.CFG file, a bilingual setup for german 
  130. and US english (can be used together with the babel package or german.sty) 
  131. is shown: 
  132. %% 
  133. %% This is file `hyphen.cfg', 
  134. %% 
  135. %% Modified for dual language support by Christian Spieler, 20. June 1994. 
  136. %% 
  137. %% This file is part of the LaTeX2e system. 
  138. %% ---------------------------------------- 
  139. %% 
  140.  
  141. \message{Loading hyphenation patterns for US english and German.} 
  142.  
  143. % PREPARING A FOREIGN LANGUAGE VERSION: 
  144. % 
  145. % This file loads hyphenation patterns for US english. 
  146. % If you want to load additional or other hyphenation patterns, 
  147. % you have to change this file, which is hereby allowed explicitly, 
  148. % under the restriction that if you do so, you MUST also change the 
  149. % message above. 
  150. % 
  151.  
  152. \message{US-English hyphenation} 
  153.  \language=0 
  154.  \chardef\l@USenglish=\language 
  155.  \input ushyphen \input ushyphen.upd 
  156.  
  157. \message{German hyphenation} 
  158.  \newlanguage\l@german 
  159.  \language=\l@german 
  160.  \input ghyphen 
  161.  
  162. \language=\l@USenglish % USenglish as Default 
  163. \lefthyphenmin=2 \righthyphenmin=3 % disallow x- or -xx breaks 
  164. \endinput 
  165. %% 
  166. %% End of file `hyphen.cfg'. 
  167.  
  168. For a nongerman country, the needed modifications are obvious. 
  169. Further information can be found in "texpert.txt" and "lthyphen.dtx". 
  170.  
  171. C) Memory requirements: 
  172. ----------------------- 
  173. LaTeX2e needs more main memory, string memory and hash space to 
  174. store its macros than previous versions of LaTeX. 
  175. Since DECUS TeX is compiled as (64 bit) BigTeX with large memory arrays, 
  176. this should not impose any problems. 
  177. When you have got a newer version of DECUS TeX (3.1415 PD 3.3a or later) 
  178. there should be enough pattern memory to load at least hyphenation patterns 
  179. for three different languages. The sizes of the current version (PD 3.5) 
  180. are: 
  181.   trie size:                    45000 
  182.   trie op size:                  1000 
  183.   trie op size per language:      511 
  184.  
  185. The bad news: 
  186. Up to now, DECUS TeX does not allow to adjust its internal arrays at 
  187. run time. Therefore, if you really need more space somewhere, you 
  188. have to recompile TeX -- the program -- with the appropiate changes, 
  189. sorry. 
  190.  
  191.  
  192.  
  193. CREATING THE LaTeX FORMAT 
  194. ========================= 
  195.  
  196. Be sure that all hyphenation pattern sources requested by HYPHEN.CFG 
  197. are accessible through the TEX_INPUTS search list. When you did not 
  198. create a HYPHEN.CFG file, at least the US english hyphenation pattern 
  199. must be found this way under the name HYPHEN.TEX. 
  200.  
  201. To create the LaTeX format the first time, you should apply 
  202. the command: 
  203.  
  204.   initex latex.ltx 
  205.  
  206. in the directory where you have unpacked the distribution. 
  207. This will create a file LATEX.FMT in this directory without 
  208. further interaction. 
  209.  
  210. This file has to be moved to the formats directory to be accessible 
  211. by the LATEX command. This can be archived by 
  212.  
  213.   RENAME LATEX.FMT TEX_FORMATS: 
  214.   SET FILE/PROTECTION=(W:RE) TEX_FORMATS:LATEX.FMT 
  215.  
  216. (If TEX_FORMATS: is located on a different disk in your installation, 
  217. you have to use the COPY command, instead. The protection setting enables 
  218. all users to use the new format.) 
  219.  
  220.  
  221.  
  222. PUTTING THE FILES WHERE LaTeX CAN READ THEM 
  223. =========================================== 
  224.  
  225. The LaTeX class and style files as well as some auxiliary .TEX files 
  226. need to be put in a directory of the TEX_INPUTS search path. In the 
  227. suggested setup, this is simply the parent directory of the location 
  228. where you have unpacked the distribution. 
  229. You should apply: 
  230.  
  231.   RENAME latexbug.tex, testpage.tex, docstrip.tex, - 
  232.       lablst.tex, idx.tex, nfssfont.tex, small2e.tex, sample2e.tex, - 
  233.       *.cls, *.clo, *.sty, *.fd, *.def, *.ist  [-] 
  234.  
  235.  
  236.  
  237. FINAL INSTALLATION STEPS 
  238. ======================== 
  239.  
  240. To use LaTeX, some preparations need to be done: 
  241.  
  242. 1.) You have to enshure that TeX looks into the right directories when 
  243.     searching for LaTeX styles and classes. In the suggested setup, 
  244.     the LaTeX core classes and styles have been put into the directory 
  245.     TEX_ROOT:[INPUTS.LATEX]. This directory needs to be part of the 
  246.     Texinputs search list, which is (normally) defined by the logical 
  247.     name TEX_INPUTS (without colon!). Check the TeX startup command file 
  248.     STARTTEX.COM (should be found in TEX_ROOT:[000000]). The list of 
  249.     equivalences in the definition of "TEX_INPUTS" should contain the 
  250.     directory where you intend to place the LaTeX2e classes. For correct 
  251.     operation, it is ABSOLUTELY neccessary that this directory is listed 
  252.     before any location of old LaTeX-2.09 files! 
  253.     (For efficiency, it might be best to place directories with frequently 
  254.     used packages/styles/classes near the top of the search list.) 
  255.  
  256. 2.) You have to modify (or add) the LATEX command definition in the TeX 
  257.     initialization procedure. The proposed setup is to use a "LATEX" DCL 
  258.     command, which gets defined in the DECUS-TEX.CLD command definition 
  259.     file. 
  260.     You have to edit the file TEX_ROOT:[EXE]DECUS-TEX.CLD. If there is no 
  261.     entry for a verb LATEX, add one by duplicating the definition for 
  262.     the verb TEX (and changing the verb name into LATEX). 
  263.     a) Modify the default value of the qualifier "FORMAT" into 
  264.        "TEX_FORMATS:LATEX" (if you had LaTeX-2.09, the old value 
  265.        was TEX_FORMATS:LPLAIN). 
  266.     b) Check, if the default value of the TEXINPUTS qualifier is 
  267.        the logical name you chose for the LaTeX2e input path. Normally 
  268.        this should be "TEX_INPUTS:" (WITH trailing colon!). 
  269.  
  270. Now you should rerun the command file TEX_ROOT:STARTTEX.COM to get the 
  271. changes to the TeX system setup into effect. 
  272. To trigger the redefinition of all TeX related logical names, you have 
  273. to delete the logical name TEX_ROOT by 
  274.    "DEASSIGN TEX_ROOT" 
  275. (or to log out and start a new session). 
  276.  
  277.  
  278.  
  279. CHECKING THAT THE INSTALLATION WORKED 
  280. ===================================== 
  281.  
  282. To check that the installation is working: 
  283.  
  284. * Be shure you have executed the STARTTEX.COM command file 
  285.   (found in the root directory of the TeX directory tree). 
  286.  
  287. * Set your current directory to TEX_ROOT:[INPUTS.LATEX.SRC] 
  288.   (or the location you used to unpack the LaTeX distribution). 
  289.  
  290. * Check that there is no file ARTICLE.CLS in this directory. 
  291.   If you have found one, rename or remove it. 
  292.  
  293. * Execute the command 
  294.  
  295.     LATEX LTXCHECK 
  296.  
  297.   This will run a test on the LaTeX installation and should produce 
  298.   'OK!' to a number of test.  If it does not, then see the `PROBLEMS' 
  299.   section in install.txt. 
  300.  
  301.   You have now installed LaTeX! 
  302.  
  303.  
  304.  
  305. POST INSTALLATION TASKS 
  306. ======================= 
  307.  
  308. In the DECUS TeX distribution, there is a command procedure FMTBUILD.COM 
  309. in the TEX_FORMATS: location to simplify recreation of all TeX formats 
  310. after a change or an update to the TeX program. You might want to 
  311. integrate the new LaTeX format into this procedure. The strategy of this 
  312. procedure is to copy all needed sources into the TEX_FORMATS: location and 
  313. building the format files right there. 
  314. To include the LaTeX format in this procecure, you have to add a section 
  315. looking similar to: 
  316. ======================= start here ======================== 
  317. $ 
  318. $LATEX: 
  319. $LaTeX_STD: 
  320. $!LaTeX (LaTeX2e release), standard configuration: 
  321. $ copy TEX_ROOT:[INPUTS.LATEX.SRC]*.ltx *.*; 
  322. $ copy TEX_ROOT:[INPUTS.LATEX.SRC]texsys.cfg *.cfg 
  323. $ copy TEX_ROOT:[INPUTS.LATEX.SRC]hyphen.cfg *.cfg 
  324. $ initex "latex.ltx" 
  325. $ dele *.ltx;* /log 
  326. $ dele texsys.aux;* /log 
  327. $ dele texsys.cfg;* /log 
  328. $ dele hyphen.cfg;* /log 
  329. $ 
  330. ====================== end here =========================== 
  331.  
  332. When you have decided to keep the LaTeX-2.09 system, you should 
  333. modify the corresponding section in FMTBUILD.COM to reflect the 
  334. changes described in the section "SAVING ANY OLD VERSION OF LaTeX"!! 
  335.  
  336.  
  337.  
  338. RUNNING LaTeX WITH OLD VERSIONS (PD V3.4 AND EARLIER) OF DECUS TeX 
  339. ================================================================== 
  340.  
  341. These version of DECUS TeX do no use the TEXINPUTS search path when 
  342. trying to open a file via \openin. This behaviour breaks the 
  343. enhance input file checking techniques implemented in LaTeX (LaTeX2e) 
  344. without further precautions. 
  345. To get around this problem, LaTeX allows an alternate way to specify the 
  346. TEXINPUTS search path to the file checking macros. This is done 
  347. through a special macro definition which has to be supplied by the 
  348. user (= LaTeX installer) via the file TEXSYS.CFG. 
  349. The following example shows a TEXSYS.CFG file which is known to work 
  350. when your LaTeX system files are accessed through the logical name 
  351. "TEX_INPUTS": 
  352.  
  353. %% texsys.cfg for DECUS TeX (VMS) 
  354. %% 
  355. % \subsection{VMS (???)} 
  356. % Some VMS implementations have different paths 
  357. % for |\openin| and |\input|. For these one could use definitions like 
  358. % the following: 
  359. % 
  360. \def\@currdir{[]} 
  361. \def\input@path{% 
  362.   {SYS$DISK:[]}% 
  363.   {TEX_INPUTS:}% 
  364. } 
  365. \endinput 
  366. %% 
  367. %% end of texsys.cfg for DECUS TeX 
  368.  
  369. For further details, see dircheck.dtx and texpert.txt. 
  370.  
  371.  
  372. --- Copyright 1994 Christian Spieler and the LaTeX3 project --- 
  373. ---              All rights reserved.                --- 
  374.